home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 3: CDPD 3 / Almathera Ten on Ten - Disc 3: CDPD3.iso / fish / 726-750 / 744 / autorunner / autorunner.doc < prev    next >
Text File  |  1995-03-18  |  12KB  |  243 lines
  1. AutoRunner -- copyright (©) 1991 by Jon Maxwell
  2. -----------------------------------------------
  3. Version 2.0
  4.  
  5.  
  6. Distribution:
  7.  
  8.    This program is Freely distributable. It is NOT Shareware, and it is
  9. NOT Public domain. What I mean is this: You can freely distribute it,
  10. following the rules below. You don't have to pay money, but I would like
  11. it very much if you do. It's NOT Public Domain because I want the rights
  12. to the program. It's NOT Shareware because I don't think it's high enough
  13. quality for that. (I KNOW it isn't, even though it is indispensible for
  14. only-floppy users)
  15.  
  16. These are the distribution rules:
  17.    1) It may not be sold for profit. This includes merely being PART OF a
  18.        disk or anything else distributed for profit. This does NOT apply
  19.        to Fred Fish (his disks aren't profit ones anyway, but..).
  20.    2) The contents of the Archive MUST NOT BE CHANGED (except by Fred Fish).
  21.        This includes altering the contents, removing parts, and adding
  22.        parts, etc.
  23.  
  24.  
  25. Disclaimer:
  26.  
  27.    I herby declare that I will accept no responsibility for damage caused
  28. by this program. Not even if it was used Properly. In other words, use it
  29. at your own risk; I'm not trying to scare you off or anything, just
  30. protecting myself in the unlikely event that somebody's data or other
  31. things might get trashed by my program, and then them wanting to sue me.
  32. I have found nothing wrong with it.
  33.  
  34.  
  35. Intro:
  36.  
  37.    You accidentally type endcli on your only CLI. You don't have workbench
  38. running. Then you decide that you want to boot up your terminal program.
  39. "Sh!t," you say, thinking of the minutes upon minutes it takes to boot up
  40. from your floppy drives. You think: "[expletive]! WHY CAN'T I JUST PUT THE
  41. DISK IN AND HAVE MY TERMINAL PROGRAM BOOT UP? WHY DO I HAVE TO TYPE 'RUN
  42. NCOMM'?" That would save you from having to boot up, and wait a minute
  43. or two. I once thought that too, and thus was this program created.
  44.  
  45.  
  46. What AutoRunner is about:
  47.  
  48.    This program does only this: When you insert a disk, it looks for its
  49. special key thing (more on this later) and then it loads a program, types
  50. a text file, or does anything else you can do from the CLI.
  51.    Have you ever noticed that the file comments just aren't used much?
  52. Well, this program uses the comments to store information on what to do
  53. when a disk is inserted. The "key" is just a special character(s) at the
  54. very beginning of the file's comment.
  55.  
  56.  
  57. How the Comments work:
  58.  
  59.    When a disk is inserted, AutoRunner looks through that disk for a
  60. comment(s) that begin with the letter "¿" or "¡". In case you don't know,
  61. these are a shift-alt-M character and an alt-i. When it finds a comment
  62. with the special character, it tries to run the rest of the comment. Thus,
  63. a comment like this: "¿Execute Term:JRCommStart" would try to execute the
  64. script JRCommStart on disk Term: .
  65.  
  66.    The "¡" started comments have exactly one character after the "¡" that is
  67. used to force the program to CD to the inserted disk. So, the above example
  68. can be changed to: "¡CExecute JRCommStart." This way, you don't have to know
  69. the name of the disk that the comment is on. More on this later.
  70.  
  71.    This comment-command, however, doesn't need to be on the comment for any
  72. particular file -- it can be on any file in the root directory. Are you
  73. excited yet? Well, try to refrain from just jumping into the program;
  74. there might actually be something you need to know in here!
  75.  
  76. (NOTE: The comments are executed in the order they appear on the disk. If
  77.  you have more than one comment-command then you might need to use the
  78.  LIST command to get them in the right order. This is a BUG, but it's not
  79.  so bad. I will try to fix it, but I don't have the energy now to do all that
  80.  sorting stuff.)
  81.  
  82.  
  83. Usage:
  84.  
  85.    From the CLI, the usage is: 1> AutoRunner ####CSO
  86. Where the 1> is just the CLI prompt, and the #'s are what units (drives)
  87. you want it to check for comment-commands on. Any of the #'s may be left
  88. out, and you can skip drives, like 02 would check df0: and df2: .  A 023
  89. would check df0:, df2:, and df3: .  At first, I just had it so that
  90. you could check a range of units, like 0-1 or 0-2 or 1-3, but then I
  91. realized that some people, like 2000 users, might have one internal drive
  92. and one external. On the 2000, the external drive is df2:, and df1: is
  93. just skipped (if you only have one internal and one external). The #'s,
  94. however, are limited to 0-3 now, since that's all the units that are
  95. currently supported by the trackdisk.device (I think).
  96.    The C, S, and O are flags. Putting a C in with the drive numbers makes
  97. it so that the program DOESN'T CD to the disk that was just inserted.
  98. Putting an S in make it NOT check all the chosen drives for commands when
  99. the program starts. Putting an O makes the program only check for
  100. comment-commands that are on the drives when the program is started. After
  101. checking and/or executing these commands, the program will immediately exit.
  102.  
  103.  
  104. Starting It:
  105.  
  106.    From the WorkBench, just click on its icon. I don't know whether or
  107. not you can change the drives that will be checked with the Workbench.
  108. I don't think so. There is a way around it, though: You can write a
  109. script that will run the program, and use IconX to run it. It's possible
  110. anyway! The program is meant to be started in one's startup-sequence
  111. anyway, so I don't think it really matters.
  112.    From the CLI, just type AutoRunner, along with the parameters (If
  113. you don't like the defaults), and return. It can be run and also
  114. RunBacked (see below).
  115.    The Defaults are: units 0&1 will be checked, 2&3 will not.
  116.                      CD to disks, and check the drives on startup.
  117.  
  118.  
  119. Running it in the Background:
  120.  
  121.    AutoRunner supports being run by Runback. If you don't use runback, any
  122. output from the program or the comment-commands will be displayed in the
  123. CLI it was started from. If you do use Runback on the program (to free up
  124. your CLI for EndCli-ing) then there will be no output. I had a problem
  125. with the WorkBench loading; it didn't open any output channels, and so the
  126. program crashed whenever it tried to write something (either a program
  127. message or a comment-command output). The only way I could see to fix this
  128. was to open a CLI window for the output (I tried sending it to NIL and it
  129. didn't work for some reason). I didn't want a big ugly CLI window with my
  130. program, though, so I resolved to make it a one-pixel (dot) CLI window. It
  131. is located in the upper left corner, so that it you Want to see output from
  132. the program, you can just put your pointer as far up and left as it goes
  133. and hold down the left button and re-size it so that it's big enough to see.
  134. This only works when it's run from the WorkBench, though.
  135.  
  136.  
  137. The AutoRunner Window:
  138.  
  139.    Appears in the upper left, just below the Screen title. Say that you
  140. didn't want a disk to be searched.. maybe because you already had your
  141. terminal program running, but wanted your terminal disk in the drive.
  142. Well, you could close the AutoRunner window (via the Close Box), which
  143. naturally quits the program, Or you could put AutoRunner into Sleep mode. To
  144. do this, activate the AutoRunner window (by clicking on it), and then click
  145. the menu button. This will change the window (and screen) title to
  146. "AutoRunner: Sleeping" Of course, in this mode, disks aren't searched though
  147. for comment-commands. And also, of course, to wake it up you just click
  148. in the window and then click the menu again.
  149.    Near the right side of the window are 4 gadgets, numbered 0 through 3.
  150. Clicking on these will re-search a disk in that drive for comment-commands.
  151.  
  152.  
  153. AutoRunner Messages:
  154.  
  155.    These appear mostly when AutoRunner has an error. They are:
  156.    1) "Can't Open Unit: #" -- This means just that. It can't open a unit
  157. (drive). This should never occur except when you gave it a unit to check
  158. that isn't there (like having it check df2: when you only have df0: and
  159. df1:). If you use the defaults and you don't have one of the drives that
  160. it checks by default then you will get this message.
  161.    2) "Bad Lock" -- This one is a little ambiguous. What it means is that
  162. it couldn't get a "lock" on the root directory of a disk. Normally, this
  163. error should be impossible. The only thing I can think of is if you have
  164. an unformated/not dos disk that you put in. The checking is there
  165. anyway, just in case, so that you don't get a GURU.
  166.    3) "Can't get a (shared) lock on <DRIVE>" -- Absolutely should not
  167. ever happen, under any circumstances. If you get this message, don't
  168. blame Autorunner if you get a GURU (AutoRunner will handle it properly,
  169. but I _think_ it means that your system is totally screwed).
  170.    4) The only other AutoRunner message is when you put a disk in with a
  171. comment-command. It prints the command to the CLI (or nowhere if it was
  172. runbacked) so that you can know what is happening.
  173.    5) All other output comes from comment-commands' output.
  174.  
  175.  
  176. Money:
  177.  
  178.    If you decide that this program is just so useful, and you use it, then
  179. send some money, please, to the following address. Also send any bug
  180. reports, suggestions, comments to the address (or the BBS -- later). Now,
  181. sending money isn't a requirement (it isn't shareware), but I spent quite
  182. a bit of time bringing you this wonderful program, making it small (despite
  183. my PD compiler), and stuff like that. If you just send me some money, maybe
  184. $10, then I'll be very happy. OR, if you feel like you owe me something, but
  185. you don't want to send money, then learn to program and/or send Commodore a
  186. big fat donation-check (they'll appreciate it, trust me -- they NEED it!).
  187. I stress that this IS NOT shareware, so you don't HAVE to send any money,
  188. but if this were compiled with a REAL compiler, then it would be a lot
  189. smaller.... and I don't have the money to get a REAL compiler (a C one maybe)
  190.  
  191. My address:
  192.    Jon Maxwell
  193.    7706 Hillview Ave.
  194.    Richmond, Virginia 23229
  195.  
  196. A BBS that I'm on:
  197.    Late Night BBS
  198.    (804)262-9944
  199.  
  200.    E-Mail Scruffy
  201.    I'm resonably sure that I'll be there, and that the BBS will still be
  202. there, but if it doesn't exist when you try to call, then just write a
  203. letter.
  204.  
  205.  
  206. Special Thanks Go To:
  207.    Tom Krehbiel, for his help with the IO messages.
  208.    Commodore (of course), for the Amiga, and for their excellence in
  209.       computer and OS design.
  210.    People who support shareware
  211.           who send money for programs that they like/use.
  212.           who buy American first (That is, people who boycott countries,
  213.                                   like Japan, that practice unfair trade
  214.                                   practices, like making it take 5 years
  215.                                   for foreigners to open a little store)
  216.           who re-cycle
  217.  
  218. Special No-Thanks go to:
  219.    People who don't want to learn.
  220.  
  221. I think that this about wraps it up:
  222.  
  223.   I can only think of a couple more things...
  224.     1) All the files in the archive MUST remain together (no leaving out
  225. files and re-uploading)
  226.     2) All files must be in their original condition (no changing things)
  227.     3) I guess I already said the above two...
  228.     4) Have fun, and enjoy automation and less typing to load programs!
  229.  
  230.  
  231. Improvements:
  232.  
  233. 1) Dispose()-ed variables. Each time a disk was inserted, it would keep
  234.    more memory. It would be released when the program ended. Now it's
  235.    released when it finished checking each disk (lowers chance of memory
  236.    fragmentation a bit, and memory doesn't get hogged by AutoRunner after
  237.    multiple disk insertions)
  238. 2) Fixed an annoying bug that "woke" the program from "sleep" when you
  239.    re-activated the window. Not really annoying unless you have a Sun
  240.    Mouse (auto activates windows when you move the pointer over them)
  241. 3) Added 0123 gadgets to allow you to easily re-load a disk's commands.
  242. 4) Changed the name from AutoRun to AutoRunner (after MenuRunner).
  243.